[BETA] Create Toppie Campaign

curl --request POST \
  --url https://api.topsort.com/public/v1/toppie/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "budget": 123,
  "targets": [
    "<string>"
  ],
  "targetRoas": 10.25,
  "budgetPeriod": "daily",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "9999-12-31T22:59:59.999999Z"
}
'

import requests

url = "https://api.topsort.com/public/v1/toppie/campaigns"

payload = {
    "name": "<string>",
    "budget": 123,
    "targets": ["<string>"],
    "targetRoas": 10.25,
    "budgetPeriod": "daily",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "9999-12-31T22:59:59.999999Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    budget: 123,
    targets: ['<string>'],
    targetRoas: 10.25,
    budgetPeriod: 'daily',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '9999-12-31T22:59:59.999999Z'
  })
};

fetch('https://api.topsort.com/public/v1/toppie/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/toppie/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'budget' => 123,
    'targets' => [
        '<string>'
    ],
    'targetRoas' => 10.25,
    'budgetPeriod' => 'daily',
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '9999-12-31T22:59:59.999999Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/toppie/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"budget\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"targetRoas\": 10.25,\n  \"budgetPeriod\": \"daily\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"9999-12-31T22:59:59.999999Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.topsort.com/public/v1/toppie/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"budget\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"targetRoas\": 10.25,\n  \"budgetPeriod\": \"daily\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"9999-12-31T22:59:59.999999Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/toppie/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"budget\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"targetRoas\": 10.25,\n  \"budgetPeriod\": \"daily\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"9999-12-31T22:59:59.999999Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "adFormat": "banner",
  "chargeType": "CPM",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "budget": 123,
  "budgetPeriod": "daily",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "targetRoas": 10.25,
  "currencyCode": "USD",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "bidCount": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

public

toppie

campaigns

[BETA] Create Toppie Campaign

curl --request POST \
  --url https://api.topsort.com/public/v1/toppie/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "budget": 123,
  "targets": [
    "<string>"
  ],
  "targetRoas": 10.25,
  "budgetPeriod": "daily",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "9999-12-31T22:59:59.999999Z"
}
'

import requests

url = "https://api.topsort.com/public/v1/toppie/campaigns"

payload = {
    "name": "<string>",
    "budget": 123,
    "targets": ["<string>"],
    "targetRoas": 10.25,
    "budgetPeriod": "daily",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "9999-12-31T22:59:59.999999Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    budget: 123,
    targets: ['<string>'],
    targetRoas: 10.25,
    budgetPeriod: 'daily',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '9999-12-31T22:59:59.999999Z'
  })
};

fetch('https://api.topsort.com/public/v1/toppie/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/toppie/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'budget' => 123,
    'targets' => [
        '<string>'
    ],
    'targetRoas' => 10.25,
    'budgetPeriod' => 'daily',
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '9999-12-31T22:59:59.999999Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/toppie/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"budget\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"targetRoas\": 10.25,\n  \"budgetPeriod\": \"daily\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"9999-12-31T22:59:59.999999Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.topsort.com/public/v1/toppie/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"budget\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"targetRoas\": 10.25,\n  \"budgetPeriod\": \"daily\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"9999-12-31T22:59:59.999999Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/toppie/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"budget\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"targetRoas\": 10.25,\n  \"budgetPeriod\": \"daily\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"9999-12-31T22:59:59.999999Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "adFormat": "banner",
  "chargeType": "CPM",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "budget": 123,
  "budgetPeriod": "daily",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "targetRoas": 10.25,
  "currencyCode": "USD",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "bidCount": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorisierungen

Authorization

string

header

erforderlich

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Body

application/json

Campaign fields to create a new agency campaign.

name

string

erforderlich

Campaign name, this will be propagated to campaigns in marketplaces

Required string length: 1 - 75

budget

integer

erforderlich

Total budget for this campaign, to be distributed across marketplaces

targets

string[]

erforderlich

List of targets for the campaign

Minimum array length: 1

targetRoas

number

erforderlich

Target ROAS for the campaign

Erforderlicher Bereich: 0.5 <= x <= 20

budgetPeriod

enum<string>

Standard:daily

The periodicity of the budget

Verfügbare Optionen:

daily,

weekly,

monthly,

total

startDate

string<date-time>

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.

endDate

string<date-time>

Standard:9999-12-31T22:59:59.999999Z

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

Antwort

Successful Response

Represents a public version of an agency campaign, used in API responses.

string<uuid>

erforderlich

Internal identifier for the agency campaign

name

string

erforderlich

Campaign name

adFormat

enum<string>

erforderlich

The ad format for this campaign

Verfügbare Optionen:

banner,

listing

chargeType

enum<string>

erforderlich

The charge type for this campaign

Verfügbare Optionen:

CPM,

CPC,

CPA

accountId

string<uuid>

erforderlich

Account that owns this campaign

budget

integer

erforderlich

Total budget for this campaign

budgetPeriod

enum<string>

erforderlich

The periodicity of the budget

Verfügbare Optionen:

daily,

weekly,

monthly,

total

startDate

string<date-time>

erforderlich

Date when the campaign starts, specified in RFC 3339. Must include the Timezone definition.

endDate

string<date-time>

erforderlich

Date when the campaign ends, specified in RFC 3339. Must include the Timezone definition.

targetRoas

number

erforderlich

Target ROAS for the campaign

Erforderlicher Bereich: 0.5 <= x <= 20

currencyCode

string

erforderlich

Currency code this campaign is working with in ISO 4217 format

Beispiel:

"USD"

isActive

boolean

erforderlich

Flag to indicate if the campaign is active or not

createdAt

string<date-time>

erforderlich

Date and time when the campaign was created

bidCount

integer | null

Bid count for the campaign (optional)

Allgemein

Auktionsbeispiele

Webhook-Beispiele

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

Placement API

Export API

API Reference

[BETA] Create Toppie Campaign

Autorisierungen

Body

Antwort